Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix documentation of FileHandle.prototype.appendFile #42588

Merged
merged 1 commit into from
Apr 3, 2022
Merged

doc: fix documentation of FileHandle.prototype.appendFile #42588

merged 1 commit into from
Apr 3, 2022

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Apr 3, 2022 •
edited
Loading

FileHandle.prototype.appendFile is an alias of FileHandle.prototype.writeFile, so it should have the same change history and documented supported data types.

node/doc/api/fs.md

Lines 658 to 683 in 80bfb9b

#### `filehandle.writeFile(data, options)`
<!-- YAML
added: v10.0.0
changes:
- version:
- v15.14.0
- v14.18.0
pr-url: https://github.com/nodejs/node/pull/37490
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
- version: v14.12.0
pr-url: https://github.com/nodejs/node/pull/34993
description: The `data` parameter will stringify an object with an
explicit `toString` function.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/31030
description: The `data` parameter won't coerce unsupported input to
strings anymore.
-->
* `data` {string|Buffer|TypedArray|DataView|Object|AsyncIterable|Iterable
|Stream}
* `options` {Object|string}
* `encoding` {string|null} The expected character encoding when `data` is a
string. **Default:** `'utf8'`
* Returns: {Promise}

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 3, 2022
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 3, 2022
@aduh95 aduh95 added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 3, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 3, 2022

Fast-track has been requested by @aduh95. Please 👍 to approve.

@aduh95 aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 3, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 3, 2022
@nodejs-github-bot nodejs-github-bot merged commit ae1f6db into nodejs:master Apr 3, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in ae1f6db

@aduh95 aduh95 deleted the fh-appendFile-doc branch April 3, 2022 20:50
aduh95 added a commit to aduh95/node that referenced this pull request Apr 4, 2022
@aduh95
doc: fix documentation of FileHandle.prototype.appendFile
808e8b1 
PR-URL: nodejs#42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
@aduh95 aduh95 mentioned this pull request Apr 4, 2022
Closed
juanarbol pushed a commit to juanarbol/node that referenced this pull request Apr 5, 2022
@aduh95 @juanarbol
doc: fix documentation of FileHandle.prototype.appendFile
73a1d22 
PR-URL: nodejs#42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
This was referenced Apr 5, 2022
Closed
Merged
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
@aduh95 @juanarbol
doc: fix documentation of FileHandle.prototype.appendFile
71f4a39 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
@aduh95 @xtx1130
doc: fix documentation of FileHandle.prototype.appendFile
2ca31c7 
PR-URL: nodejs#42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
juanarbol pushed a commit that referenced this pull request May 1, 2022
@aduh95 @juanarbol
doc: fix documentation of FileHandle.prototype.appendFile
77ba012 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Backport-PR-URL: #42603
@juanarbol juanarbol mentioned this pull request May 1, 2022
Merged
juanarbol pushed a commit that referenced this pull request May 31, 2022
@aduh95 @juanarbol
doc: fix documentation of FileHandle.prototype.appendFile
6d2d2b5 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
@juanarbol juanarbol mentioned this pull request May 31, 2022
Closed
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
@aduh95 @danielleadams
doc: fix documentation of FileHandle.prototype.appendFile
40f6131 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
targos pushed a commit that referenced this pull request Jul 11, 2022
@aduh95 @targos
doc: fix documentation of FileHandle.prototype.appendFile
98a042b 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
@aduh95 @targos
doc: fix documentation of FileHandle.prototype.appendFile
8072adf 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
@targos targos mentioned this pull request Aug 3, 2022
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@aduh95 @guangwong
doc: fix documentation of FileHandle.prototype.appendFile
9f4213a 
PR-URL: nodejs/node#42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mesteery Mesteery Mesteery approved these changes

@RaisinTen RaisinTen RaisinTen approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@aduh95 @nodejs-github-bot @jasnell @lpinca @RaisinTen @Mesteery @targos